home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / tri_bbs / ttlvl20.zip / TRILEVEL.DOC < prev    next >
Text File  |  1991-08-12  |  12KB  |  319 lines
  1.  
  2.   *NOTE* As of 8/12/91 TriLevel is a free program in the Public Domain.
  3.          All features are available and you should ignore any reference
  4.          to "Registered" features.  You have them!
  5.          Also the support BBS, Guru Mountain, is no longer in existance.
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.                           T R I - L E V E L
  14.                                  for
  15.                        T r i T e l   B B S ' s
  16.                                    
  17.                  Copyright (c) 1991 By Jerry Halstead
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.      TriLevel is a utility for TriTel BBSs that allows the Sysop to
  27. automatically adjust user levels according to up/download ratios or
  28. using a subscription method.  TriLevel allows:
  29.  
  30.      - Raising security levels by preset up/download ratios.
  31.      - Lowering security levels when ratio is exceeded.
  32.      - Subscription Users file to maintain varying levels of
  33.        security levels on user-by-user basis.
  34.      - Feedback report of all adjusted levels and reasons.
  35.        (can be piped to Callers log for added convienience)
  36.      - Using TriTel's user logon screen function, expiring  
  37.        subscriptions generate a reminder LOGON screen to the user.    
  38.                     *ONLY ON REGISTERED VERSION*
  39.        (See your TriTel docs for more info on user logon screens)
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  ****  WARNING  ****  WARNING  ****  WARNING  ****   WARNING  ****
  48.  
  49.  
  50.  
  51.  
  52.      I cannot be held responisible for any problems or damage incurred
  53. from using TriLevel.  You alone are responsible for reading the
  54. documentation and understanding the setup and configurations for this
  55. program and how they pertain to your own BBS setup.  No guarantees,
  56. written or assumed, are given with TriLevel and it is not considered
  57. a part of the TriTel BBS distributed and written by Mark Goodwin.
  58.  
  59.      If you do not agree with any of the above or do not understand
  60. any portion of the documentation you are urged not to run TriLevel.
  61.  
  62.  
  63.  ****  WARNING  ****  WARNING  ****  WARNING  ****   WARNING  ****
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.      TriLevel is being distributed as Shareware.  If you find this
  72. program to be a valuable addition to your TriTel BBS I urge you to
  73. register it.  Support for the program and the latest version can be
  74. found on my BBS, Guru Mountain, at (603) 448-0198 (USR Dual Standard).
  75. Registered versions will automatically send subscribers a reminder
  76. message (using TriTel's User Logon screen function) that their
  77. subscription is expiring 30 days prior to their last day.  It will
  78. also generate a message when users security levels have been lowered
  79. due to exceeding their up/download ratios.
  80.      
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90. SETUP
  91. -----
  92.  
  93.      You should have recieved the following files in your TriLevel
  94. package:
  95.  
  96.           TRILEVEL.EXE...The main program.
  97.           TRILEVEL.DOC...This file.
  98.           TRILEVEL.KEY...* The KEY file for registered versions.
  99.           MESSAGES.BAT...* TriLevel generated message maker - example.
  100.           LEVELS.CFG.....Sample up/download configuration file.
  101.           SUBSCRIP.CFG...Sample subscription configuration file.
  102.           TRILEVEL.......Sample event batch file for TriLevel.
  103.           EXPIRING.ANS...* Sample expiration logon message, ANSI. - example
  104.           EXPIRING.BBS...* Sample expiration logon message, text. - example
  105.           EXPIRED.ANS....* Sample expired subscription message.   - example
  106.           EXPIRED.ANS....* Sample expired subscription message.   - example
  107.           LOWERED.ANS....* Sample lowered access message, ANSI.   - example
  108.           LOWERED.BBS....* Sample lowered access message, text.   - example
  109.           RAISED.ANS.....* Sample raised access message, ANSI.    - example
  110.           RAISED.BBS.....* Sample raised access message, text.    - example
  111.           PAID.ANS.......* Sample new subscription message, ANSI. - example
  112.           PAID.BBS.......* Sample new subscription message, text. - example
  113.  
  114.                           * (for registered version only)
  115.  
  116.  
  117.  
  118.                 **************WARNING****************
  119.  
  120. Since TriLevel directly modifies your USERS.DAT file, it is STRONGLY
  121. suggested that you make backup copies before running this program.  It
  122. is even suggested that you put a line like:
  123.  
  124.        COPY C:\TRITEL\WORK\USERS.DAT C:\TRITEL\WORK\USERS.BAK
  125.  
  126. into your TriLevel batch file to be on the safe side.
  127.  
  128.                 *************************************
  129.  
  130.  
  131.      Copy all of the files into their own directory.  The files do not
  132. have to be in any of the TriTel directories, but they all need to be
  133. together.  The best way to run TriLevel is as an EVENT once a day.
  134. The syntax for running TriLevel is:
  135.  
  136. TRILEVEL C:\TRITEL
  137.               ^
  138.               |
  139.                \
  140.                 The directory with Tritel in it.
  141.  
  142.      TriLevel looks for USERS.DAT in the WORK directory and, if
  143. registered, puts the subscriber's logon messages in the DISPLAY
  144. directory.  Should you want to run TriLevel on a test basis you could
  145. make a dummy directory with a WORK and DISPLAY subdirectory and copy
  146. USERS.DAT to the WORK directory.  Invoking TriLevel with this dummy
  147. directory would only modify the copied USERS.DAT.
  148.  
  149.      TriLevel reads the LEVELS.CFG file for instructions on setting
  150. your user's security levels according to up/download ratios.  The file
  151. SUBSCRIP.CFG holds your subscriber's information and access levels.
  152. TriLevel looks for both of these files in the directory it is run
  153. from.  Both files are ASCII format and can be edited with most text
  154. editors.  The formats are as follows:
  155.  
  156.  
  157. LEVELS.CFG
  158. ----------
  159.  
  160. 10,20,10
  161. 20,60,5
  162.  
  163. ^  ^  ^
  164. |  |   \
  165. |  |    The Download to Upload ratio that determines level
  166. |  |     (# of downloads divided by # of uploads)
  167. |   \
  168. |    Level to set user at when they are below ratio
  169. |
  170.  \
  171.   Level of user to check ratio against.
  172.   (Also level they drop to if they exceed the ratio)
  173.  
  174.  
  175.      This is the most difficult part of the setup.  In the above
  176. example a level 10 user with a 2:1 ratio (two downloads, 1 upload)
  177. would first be given access level 20 and then immediately given access
  178. level 60.  If that same user then becomes a 6:1 ratio, TriLevel would
  179. drop them down to a level 20.  A 11:1 ratio would put the user back at
  180. level 10.  The most important point when doing multiple level
  181. adjustments is that the program works from the top down.  That is,
  182. TriLevel adjusts the users level according to the first line first,
  183. then the second, the third, and so on.
  184.      In the above example, TriLevel will only check users with the
  185. access levels of 10, 20, and 60 and adjust them accordingly.  Most
  186. BBS's would only need one line for their LEVELS.CFG file, like:
  187.  
  188.  
  189. 10,30,15
  190.  
  191.  
  192.      This would adjust any level 10 users with a down/up ratio of less
  193. than 15:1 to level 30.  Also, it would adjust any level 30 users who
  194. exceed the 15:1 ratio back down to level 10.
  195.  
  196.      If you are running the registered version of TriLevel, all users
  197. who's access level is lowered are sent the LOWERED.ANS & LOWERED.BBS
  198. messages via the User Logon message function of TriTel.
  199.  
  200.  
  201. SUBSCRIP.CFG
  202. ------------
  203.  
  204. 104,04/13/92,70,30
  205. 91,01/01/90,70,10
  206.  
  207. ^     ^      ^  ^
  208. |     |      |   \
  209. |     |      |     Expiration level
  210. |     |       \
  211. |     |         Subscription level
  212. |      \
  213. |        Subscription end date
  214.  \
  215.   User Number
  216.  
  217.  
  218.      TriLevel uses this file to determine which users are subscribers
  219. and what their level should be.  For each subscriber you enter a line
  220. of text like above containing: User Number, Expiration Date, Sub-
  221. scription Level, and Expiration Level.  TriLevel will compare today's
  222. date to the expiration date and set the users security level to the
  223. Subscription level if it is greater than today, and to the Expiration
  224. level if less than today.
  225.  
  226.     ***> NOTE: Do not use any additional characters or spaces <***
  227.  
  228.      If you are running the registered version, TriLevel will also
  229. check for Users who's subscription expires in 30 days and sends them
  230. the EXPIRE.ANS & EXPIRE.BBS files as User Logon messages.  *NOTE: If
  231. you do not run TriLevel every day you may miss the warning, as it is
  232. only sent exactly 30 days prior to expiration.
  233.  
  234.  
  235.  
  236.  
  237. TRILEVEL   (TriTel EVENT Batch file example)
  238. ---------
  239.  
  240. cd \events\trilevel
  241. TRILEVEL.EXE  C:\TRITEL >> TRILEVEL.LOG
  242. cd \tritel
  243. board
  244.  
  245.  
  246.      The TriLevel batch file is relatively straight forward.  First it
  247. switches to the directory with all of the TriLevel files and then it
  248. calls TriLevel WITH the path to your TriTel files.
  249.      The ">> TRILEVEL.LOG" is an optional pipe (see your DOS manual
  250. for more information on pipes & redirection) that sends the output of
  251. TriLevel to a file called TRILEVEL.LOG.  The ">>" means to append the
  252. information to the end of the file so you should note that the file
  253. can grow quite large after some time.  You could replace the ">>" with
  254. a ">" which work erase the old TRILEVEL.LOG file each time and write
  255. today's output only.  Another interesting method would be to use the
  256. following:
  257.  
  258.  
  259. TRILEVEL.EXE C:\TRITEL  >> C:\TRITEL\WORK\CALLERS.LOG
  260.  
  261.  
  262.      This would put the results of TriLevels adjustments into your
  263. callers log so you could view it on-line.  Again, this will append
  264. and it will result in a larger callers file, especially if you have a
  265. large number of users being adjusted daily.  It is suggested that you
  266. not use the ">" to pipe to the callers file since it will erase all of
  267. your recent caller activity.
  268.  
  269.      The TRILEVEL batch file can be invoked manually by the Sysop or by
  270. TriTel's EVENTS function.  See your TriTel Documentation for a more
  271. thorough explanation of setting up events.
  272.  
  273.  
  274.  
  275. PRIORITIES:
  276.  
  277.      TriLevel works from the top down.  It adjusts the users by file
  278. ratios this way and then adjusts the subscriptions this way.  The last
  279. entry in either file is the last parameter to be acted on.
  280. SUBSCRIPTIONS are adjusted last, so no matter what the DOWN/UPLOAD
  281. ratios do to a caller, the Subscriptions can override them.  So if
  282. user # 223 is level 50 with a ratio of 30:1 and exceeds a level 50
  283. setting in the LEVELS.CFG file, the SUBSCRIP.CFG file will re-adjust
  284. it back to 50.  This is not a good way to set things up since you will
  285. get a lot of extraneous messages from all of the adjusting.
  286.  
  287.  
  288.  
  289.  
  290. REGISTERED GOODIES:
  291.  
  292.      If you have a registered copy of TriLevel you will get a couple
  293. added benefits.  TriTel supports (as of version 1.1) sending messages
  294. to individual users at logon by putting a file in the display
  295. directory with their user # and .ANS & .BBS for extensions.  Customize
  296. the file(s) LOWERED.BBS and/or LOWERED.ANS in the TriLevel directory,
  297. TriLevel will "send" them to each user # that is lowered. While the two
  298. RAISED files are displayed to users who's access is raised because of
  299. up/download ratios.  EXPIRED.ANS & .BBS are displayed when a registered
  300. user gets lowered access after subscription period is over. The files
  301. EXPIRE.BBS and EXPIRE.ANS work the same way except they are only sent
  302. when a user has exactly 30 days until their subscription expires.  A
  303. brand new subscriber will be shown the PAID.ANS or PAID.BBS files ONLY
  304. if TriLevel is the one to make the raise in security.
  305.      I have seperated the actual user screen generation to another step
  306. so Sysops have a little more control over how and when it happens.  The
  307. default method to generate the users messages is to run MESSAGES.BAT
  308. right after TriLevel.
  309.  
  310.  
  311. cd \events\trilevel
  312. TRILEVEL.EXE  C:\TRITEL >> TRILEVEL.LOG
  313. CALL MESSAGES
  314. cd \tritel
  315. board
  316.  
  317.  
  318.  
  319.